// Written in the D Programming Language
/*
 * Copyright (c) 2008 OpenGLUtils
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'OpenGLUtils' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
module openglutils.GLError;

import Int = tango.text.convert.Integer;
import Str = tango.stdc.stringz;

import derelict.opengl.gl;
import derelict.opengl.glu;

import openglutils.GLException;

/**
 * Checks if there is a pending OpenGL error, and throws a GLException if true.
 * 
 * Params:
 *     funcName = the function's name that was previously called 
 *     insideGLBegin = a flag indicating if we are between calls to glBegin and glEnd, default: false
 */
public void glCheckError(char[] funcName, bool insideGLBegin = false)
{
	if (!insideGLBegin)
	{
		GLenum error = glGetError();
		if (error != GL_NO_ERROR)
		{
			throw new GLException("error " ~ Int.toString(error) ~ ": '" ~ getGLError(error) ~ "' in: " ~ funcName);
		}
	}
}

/**
 * Converts a GLenum error code to a string.
 * 
 * Params:
 *     error = the error code 
 * Returns: A string presentation of the given error code.
 */
public char[] getGLError(GLenum error)
{
	return Str.fromStringz(cast(char*) gluErrorString(error));
}
